feat: Add methods to store & restore UI component state by tobezdev · Pull Request #3208 · Pycord-Development/pycord

tobezdev · 2026-04-18T20:01:22Z

Summary

Addresses issue #2385 by adding methods to store and restore UI component states via new methods ui.View.to_component_instances() & ui.View.from_components(). The method View.from_components() has also been edited to preserve row indexes by using enumerate() rather than _walk_all_components().

Note: I have intentionally not updated any formal documentation (markdown files) as I do not believe this is required. Any new functions have docstrings explaining their exact behaviour (and their code is very readable anyways). Anything existing has not been fundamentally changed so there will be no difference in terms of how people will use those methods. Please let me know if a documentation change is required and I will be happy to add this into the PR.

The Copilot CLI was used in the development of this PR, although no code was generated by it. It was used simply to identify an issue on this repo that I could have an attempt at using the GitHub MCP server, and I used it to understand the structure and standards of the already-existing code (for example, the format of docstrings).

Information

This PR fixes an issue.
This PR adds something new (e.g. new method or parameters).
This PR is a breaking change (e.g. methods or parameters removed/renamed).
This PR is not a code change (e.g. documentation, README, typehinting,
examples, ...).

Checklist

I have searched the open pull requests for duplicates.
If code changes were made then they have been tested.
- I have updated the documentation to reflect the changes.
If type: ignore comments were used, a comment is also left explaining why.
I have updated the changelog to include these changes.
AI Usage has been disclosed.
- If AI has been used, I understand fully what the code does
I have read the Contributing Guidelines

Add to_component_instances() and from_components() to View and DesignerView for component-instance state round-tripping.

When importing ActionRow component instances, assign the source row index to items before adding them so exported View layouts round-trip accurately.

Add View and DesignerView tests for to_component_instances()/from_components().

pycord-app · 2026-04-18T20:01:28Z

Thanks for opening this pull request!
Please make sure you have read the Contributing Guidelines and Code of Conduct.

This pull request can be checked-out with:

git fetch origin pull/3208/head:pr-3208
git checkout pr-3208

This pull request can be installed with:

pip install git+https://github.com/Pycord-Development/pycord@refs/pull/3208/head

Co-authored-by: Paillat <jeremiecotti@ik.me> Signed-off-by: Toby <83095177+tobezdev@users.noreply.github.com>

Copilot

Pull request overview

Adds a way to snapshot and restore discord.ui view state using component instances (rather than raw payload dicts), addressing the need described in #2385.

Changes:

Add to_component_instances() to View and DesignerView for exporting in-memory Component instances.
Add from_components() to View and DesignerView for restoring views from component instances (with row preservation for legacy View ActionRows).
Add unit tests covering round-tripping for both View and DesignerView.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
`discord/ui/view.py`	Introduces component-instance export/import APIs for `View` and `DesignerView`.
`tests/ui/test_view_component_instances.py`	Adds round-trip tests for the new APIs and confirms existing dict-based behavior remains unchanged.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

NeloBlivion

Misc.

This should target the base ItemInterface class to support modals as well.
I'm not sure if a testing implementation is necessary here considering we do not have any tests implemented besides voice
This should be considered after #3093 is merged

Add to_component_instances() method which returns the underlying instances from a list of components

to_component_instances() now targets the shared base layer & added on ItemInterface using each item’s _generate_underlying(), and exposed from BaseView so DesignerView no longer duplicates it

Adjusted _generate_underlying() to allow already-backed items and allows usage on ItemInterface

Nelo asked for support for `ItemInterface` so dont ask me ok

Signed-off-by: Lala Sabathil <lala@pycord.dev>

vmphase · 2026-08-03T09:12:52Z


 ### Added

+- Methods to store and restore states of UI components.


Suggested change

- Methods to store and restore states of UI components.

- Added `View.to_component_instances()`/`from_components()` for snapshotting and

restoring UI component state.

vmphase

The test failure is caused by a test-ordering effect. pytest-asyncio tears down a function-scoped loop after each async test, leaving _set_called=True and _loop=None. That's why asyncio.get_event_loop() raises a RuntimeError in the later sync voice tests instead of auto-creating a loop.

Bulk-accept my requested changes to add an autouse fixture that resets the loop state after every test, and this will be good to go.

P.S.: Ideally, this fixture belongs into conftest.py file. Since we don't have one yet and this is yet the only file with async tests, it's fine to leave it here for now. I will move it within a separate cleanup PR later.

vmphase · 2026-08-03T09:51:31Z

+
+import pytest


Suggested change

import pytest

import asyncio

import pytest

vmphase · 2026-08-03T09:53:42Z

+from discord.components import InputText as InputTextComponent
+
+
+@pytest.mark.asyncio


Suggested change

from discord.components import InputText as InputTextComponent

@pytest.mark.asyncio

from discord.components import InputText as InputTextComponent

@pytest.fixture(autouse=True)

def _restore_event_loop_after_async_tests():

yield

asyncio.set_event_loop(asyncio.new_event_loop())

@pytest.mark.asyncio

tobezdev added 4 commits April 18, 2026 20:30

feat(ui): add component instance APIs

aa511db

Add to_component_instances() and from_components() to View and DesignerView for component-instance state round-tripping.

fix(ui): preserve row indexes in View.from_components

658a63d

When importing ActionRow component instances, assign the source row index to items before adding them so exported View layouts round-trip accurately.

test(ui): add component-instance roundtrip coverage

9157baa

Add View and DesignerView tests for to_component_instances()/from_components().

chore: add pycord MIT license text

2b8b101

tobezdev requested review from a team and Copilot April 18, 2026 20:01

github-project-automation Bot added this to Pycord Apr 18, 2026

tobezdev requested review from Lulalaby, Paillat-dev and Soheab April 18, 2026 20:01

github-project-automation Bot moved this to Todo in Pycord Apr 18, 2026

tobezdev requested a review from a team as a code owner April 18, 2026 20:01

pullapprove4 Bot added PA: All Contributors pending PA: Maintainers pending labels Apr 18, 2026

Copilot started reviewing on behalf of tobezdev April 18, 2026 20:01 View session

tobezdev changed the title ~~Add method to store & restore UI component state (addresses #2385)~~ Add method to store & restore UI component state Apr 18, 2026

Paillat-dev requested review from NeloBlivion and removed request for Copilot April 18, 2026 20:03

tobezdev changed the title ~~Add method to store & restore UI component state~~ feat: Add methods to store & restore UI component state Apr 18, 2026

Paillat-dev reviewed Apr 18, 2026

View reviewed changes

Comment thread tests/ui/test_view_component_instances.py Outdated

Remove copyright line from MIT license

f25a326

Co-authored-by: Paillat <jeremiecotti@ik.me> Signed-off-by: Toby <83095177+tobezdev@users.noreply.github.com>

Copilot AI review requested due to automatic review settings April 18, 2026 20:05

Copilot started reviewing on behalf of tobezdev April 18, 2026 20:06 View session

Copilot AI reviewed Apr 18, 2026

View reviewed changes

Comment thread discord/ui/view.py Outdated

Comment thread tests/ui/test_view_component_instances.py

Lulalaby added the hold: changelog This pull request is missing a changelog entry label Apr 18, 2026

docs(changelog): add this PR to changelog under unreleased > added

36eea75

tobezdev requested a review from a team as a code owner April 18, 2026 20:25

tobezdev requested review from a team and EmmmaTech April 18, 2026 20:25

style(pre-commit): auto fixes from pre-commit.com hooks

18d63e5

NeloBlivion requested changes Apr 18, 2026

View reviewed changes

Comment thread discord/ui/view.py Outdated

Comment thread discord/ui/view.py

Comment thread discord/ui/view.py

Comment thread discord/ui/view.py Outdated

pullapprove4 Bot removed PA: All Contributors pending PA: Maintainers pending labels Apr 18, 2026

tobezdev and others added 8 commits April 18, 2026 22:35

feat(core): add to_component_instances method

1a19581

Add to_component_instances() method which returns the underlying instances from a list of components

fix(ui views): update to_component_instances() to support

0186380

to_component_instances() now targets the shared base layer & added on ItemInterface using each item’s _generate_underlying(), and exposed from BaseView so DesignerView no longer duplicates it

feat: update _generate_underlying()

9d6c4b4

Adjusted _generate_underlying() to allow already-backed items and allows usage on ItemInterface

chore(tests): add new test for InputTextComponent

a5a7255

Nelo asked for support for `ItemInterface` so dont ask me ok

style(pre-commit): auto fixes from pre-commit.com hooks

99a71ae

Merge branch 'Pycord-Development:master' into master

a2ce3fd

Merge branch 'Pycord-Development:master' into master

80823a3

Merge branch 'master' into master

470252c

Signed-off-by: Lala Sabathil <lala@pycord.dev>

Lulalaby requested a review from a team as a code owner July 30, 2026 13:24

github-actions Bot added the invalid This doesn't seem right label Jul 30, 2026

This comment was marked as resolved.

Sign in to view

github-actions Bot closed this Jul 30, 2026

github-actions Bot locked as spam and limited conversation to collaborators Jul 30, 2026

github-project-automation Bot moved this from Todo to Done in Pycord Jul 30, 2026

Paillat-dev reopened this Jul 30, 2026

Pycord-Development unlocked this conversation Jul 30, 2026

Paillat-dev removed the invalid This doesn't seem right label Jul 30, 2026

Lulalaby and others added 2 commits July 30, 2026 15:41

Merge branch 'master' into master

327a933

Merge branch 'master' into master

c174f0a

vmphase reviewed Aug 3, 2026

View reviewed changes

vmphase requested changes Aug 3, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: Add methods to store & restore UI component state - #3208

feat: Add methods to store & restore UI component state#3208
tobezdev wants to merge 17 commits into
Pycord-Development:masterfrom
tobezdev:master

tobezdev commented Apr 18, 2026 •

edited by Lulalaby

Loading

Uh oh!

pycord-app Bot commented Apr 18, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

NeloBlivion left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as resolved.

vmphase Aug 3, 2026

Uh oh!

vmphase left a comment

Uh oh!

vmphase Aug 3, 2026

Uh oh!

vmphase Aug 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants


		### Added

		- Methods to store and restore states of UI components.

	- Methods to store and restore states of UI components.
	- Added `View.to_component_instances()`/`from_components()` for snapshotting and
	restoring UI component state.

		from discord.components import InputText as InputTextComponent


		@pytest.mark.asyncio

Uh oh!

Uh oh!

Conversation

tobezdev commented Apr 18, 2026 • edited by Lulalaby Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Information

Checklist

Uh oh!

pycord-app Bot commented Apr 18, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

NeloBlivion left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as resolved.

vmphase Aug 3, 2026

Choose a reason for hiding this comment

Uh oh!

vmphase left a comment

Choose a reason for hiding this comment

Uh oh!

vmphase Aug 3, 2026

Choose a reason for hiding this comment

Uh oh!

vmphase Aug 3, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

tobezdev commented Apr 18, 2026 •

edited by Lulalaby

Loading